CodeLink: Using a Semantic Wiki for Code Documentation
نویسنده
چکیده
Documentation maintainence is a difficult and costly process. Existing forms of software documentation exist independent from the code it describes. As a result, problems arise when source code evolves since there is no traceability between the documentation and code domains. CodeLink, a semantic wiki designed for code documentation attempts to address this problem. CodeLink provides a platform for establishing traceability links between developer documentation and code concepts. Traceability links between documentation and code can be explicitly created by the user through annotations, or inferred through the use of natural language analysis. CodeLink employs an ontology as its knowledge model and a semantic wiki as its user interface. Annotations on traceability relations in the ontology serve to connect natural language phrases with formal ontology concepts. In this paper, the motivation, design and implementation of CodeLink are described. Particular focus is placed on the natural language processing (NLP) component of CodeLink. The process in which the NLP component infers traceability links from the natural language text in the semantic wiki is described in depth. Several methods of querying and retrieving information from the knowledge model are discussed, followed by a summary of related and future work.
منابع مشابه
Using Ontologies For Software Documentation
High quality software documentation is a substantial issue to understand software systems. Shorter time-to-market software cycles increase the importance of automatism to keep the documentation up to date. In this paper, we describe the automatic support of the software documentation process using a social semantic software approach. Therefore, we introduce a software documentation ontology as ...
متن کاملUsing a Semantic Wiki for Documentation Management in Very Small Projects
The emerging ISO/IEC 29110 standard Lifecycle profiles for Very Small Entities is targeted at very small entity (VSE) having up to 25 people, to assist them unlock the potential benefits of using software engineering standards. VSEs may use semantic web technologies to improve documentation management infrastructure and processes. We proposed to use a semantic wiki for documentation management ...
متن کاملA Semantic Wiki on Cooperation in Public Administration
Authorities cooperate in various ways. The Web portal www.verwaltungskooperation.at aims to share knowledge on collaboration projects. A semantic wiki approach was used to facilitate best practice documentation with Semantic Web and Web 2.0 technology.
متن کاملOntology-enabled Documentation of Service-oriented Architectures with Ontobrowse Semantic Wiki
Documenting and maintaining an enterprise-wide service-oriented architecture (SOA) causes a substantial management effort, which should be addressed by intelligent, scalable solutions. A particular challenge is that business experts, developers, and software architects take different perspectives on a SOA, each favoring various description formats and sources, which leads towards a scattering o...
متن کاملPlDoc: Wiki style Literate Programming for Prolog
This document introduces PlDoc, a literate programming system for Prolog. Starting point for PlDoc was minimal distraction from the programming task and maximal immediate reward, attempting to seduce the programmer to use the system. Minimal distraction is achieved using structured comments that are as closely as possible related to common Prolog documentation practices. Immediate reward is pro...
متن کاملذخیره در منابع من
با ذخیره ی این منبع در منابع من، دسترسی به آن را برای استفاده های بعدی آسان تر کنید
عنوان ژورنال:
دوره شماره
صفحات -
تاریخ انتشار 2007